package com.bingxue.edu.management.generator.service;

import com.bingxue.edu.framework.common.model.PageQuery;
import com.bingxue.edu.framework.common.model.Pagination;
import com.bingxue.edu.management.generator.model.entity.FieldConfig;
import com.bingxue.edu.management.generator.model.entity.GenConfig;
import com.bingxue.edu.management.generator.model.query.TableQuery;
import com.bingxue.edu.management.generator.model.req.GenConfigReq;
import com.bingxue.edu.management.generator.model.resp.TableResp;

import java.sql.SQLException;
import java.util.List;

/**
 * 表结构查询接口
 * @author panbo
 * @since 2024/7/22
 */
public interface TableMetaService {

    /**
     * 分页查询表信息列表
     *
     * @param query     查询条件
     * @param pageQuery 分页查询条件
     * @return 表信息分页列表
     * @throws SQLException /
     */
    Pagination<TableResp> pageTable(TableQuery query, PageQuery pageQuery) throws SQLException;

    /**
     * 查询生成配置信息
     *
     * @param tableName 表名称
     * @return 生成配置信息
     * @throws SQLException /
     */
    GenConfig getGenConfig(String tableName) throws SQLException;

    /**
     * 查询字段配置列表
     *
     * @param tableName   表名称
     * @param requireSync 是否需要同步
     * @return 字段配置列表
     */
    List<FieldConfig> listFieldConfig(String tableName, Boolean requireSync);

    GenConfig getGenConfigById(String tableName);

    List<FieldConfig> listFieldConfigByTableName(String tableName);

    /**
     * 保存代码生成配置信息
     *
     * @param req       代码生成配置信息
     * @param tableName 表名称
     */
    void saveConfig(GenConfigReq req, String tableName);
}
